System APIs
RamBase event type details for provided identifier
HTTP method | GET |
URI | https://api.rambase.net/system/rambase-event-types/{rambaseEventTypeId} |
Supported formats | Xml, Html, Json (ex. $format=json) |
- URI parameter {rambaseEventTypeId} |
RamBase event type identifier
Integer, minimum 100000 |
Successful HTTP status code | 200 |
API resource identifier | 254, version 25 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
$showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
$lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
$access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
$db String, optional | Set the database/company for the request |
$format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
$useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
$select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information. |
$expand String, optional | Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RamBaseEventTypeId
RamBase event type identifier
>{Integer}</RamBaseEventTypeId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Key
Key of the Event Type. This key will be used to identify which event to fire.
>{String}</Key>Name
Name of the rambase event type. This should be more human readable than eventtype.
>{String}</Name>Namespace
Namespace of the rambase event type
>{String}</Namespace>AllowWebhooks
If the Event Type can be used to create webhooks
>{Boolean}</AllowWebhooks>AllowAutomatedFlows
Whether this event type can be used in an automated flow.
>{Boolean}</AllowAutomatedFlows>Description
Description of the Event Type
>{String}</Description>ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
>{String}</ObjectDetailsUri>RamBaseEventTypeId
RamBase event type identifier
": "{Integer}",Status
Status of the Event Type
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",Key
Key of the Event Type. This key will be used to identify which event to fire.
": "{String}",Name
Name of the rambase event type. This should be more human readable than eventtype.
": "{String}",Namespace
Namespace of the rambase event type
": "{String}",AllowWebhooks
If the Event Type can be used to create webhooks
": "{Boolean}",AllowAutomatedFlows
Whether this event type can be used in an automated flow.
": "{Boolean}",Description
Description of the Event Type
": "{String}",ObjectDetailsUri
API location for where to find more information about the object this event occurred for. May contains placeholders from with reference to parameter names. The parameter names are case sensitive.
": "{String}",
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
Error 101814 HTTP 404 | Employee not found |